Feat: Implement a basic Zotero picker compatible CAYW endpoint by palukku · Pull Request #13185 · JabRef/jabref

palukku · 2025-05-30T00:52:16Z

Adds the ability to use the extensions which normally can be used with better-bibtex to startup the cayw citation picker in zotero.

Closes #13187

The cayw endpoint and gui can be opened with

curl http://localhost:23119/better-bibtex/cayw

after that it opens up a window where you can search

Provide path to bif file - and say JSON format

curl http://localhost:23119/better-bibtex/cayw?librarypath=C%3A%5CUsers%5CDEMO%5CDownloads%5CChocolate.bib&format=json

Mandatory checks

I own the copyright of the code submitted and I license it under the MIT license
Change in CHANGELOG.md described in a way that is understandable for the average user (if change is visible to the user)
[/] Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
Screenshots added in PR description (if change is visible to the user)
[/] Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
[/] Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

jabsrv/src/main/java/module-info.java

jabsrv/src/main/java/org/jabref/http/server/cayw/CAYWResource.java

jabsrv/src/main/java/org/jabref/http/server/cayw/gui/SearchDialog.java

jabsrv/src/main/java/org/jabref/http/server/cayw/gui/SearchField.java

subhramit

Great progress so far, Philip!
I have left some comments.

Also, if possible, please add javadoc to every non-trivial method you write during the project (by non-trivial I mean ones which are not getX, setZ or displayP etc.) so that any maintainer taking a walk can review your code easily without having to gather context.
^This suggestion holds for all GSoC students @Yubo-Cao @Kaan0029 @wanling0000.

jabsrv/src/main/java/org/jabref/http/server/cayw/CAYWResource.java

jabsrv/src/main/java/org/jabref/http/server/cayw/gui/SearchResultContainer.java

jabsrv/src/main/java/org/jabref/http/server/cayw/gui/SelectedItemsContainer.java

koppor · 2025-05-30T11:37:59Z

Tmp moved to JabRef#709

trag-bot · 2025-07-01T21:02:25Z

jabsrv/src/main/java/org/jabref/http/server/cayw/CAYWResource.java

+
+    /// @return a stream to the `Chocolate.bib` file in the classpath (is null only if the file was moved or there are issues with the classpath)
+    private @Nullable InputStream getChocolateBibAsStream() {
+        return BibDatabase.class.getResourceAsStream(CHOCOLATEBIB_PATH);


Method can return null but doesn't use Optional to explicitly handle the null case, violating the principle of not returning null from public methods.

trag-bot · 2025-07-01T21:02:27Z

jabsrv/src/main/java/org/jabref/http/server/cayw/CAYWResource.java

+        Platform.runLater(() -> {
+                SearchDialog<BibEntry> dialog = new SearchDialog<>();


GUI code is directly implemented in the resource class instead of being delegated to a proper logic layer in org.jabref.logic package.

Co-authored-by: Subhramit Basu <subhramit.bb@live.in>

trag-bot · 2025-07-01T21:06:56Z

@trag-bot didn't find any issues in the code! ✅✨

trag-bot · 2025-07-01T21:08:19Z

@trag-bot didn't find any issues in the code! ✅✨

jabref-machine · 2025-07-01T21:12:45Z

JUnit tests of jablib are failing. You can see which checks are failing by locating the box "Some checks were not successful" on the pull request page. To see the test output, locate "Tests / Unit tests (pull_request)" and click on it.

You can then run these tests in IntelliJ to reproduce the failing tests locally. We offer a quick test running howto in the section Final build system checks in our setup guide.

palukku added 2 commits May 30, 2025 02:49

initial cayw

ea620a5

Merge branch 'main' into cayw

7d57d0e